RangeTo Method

Wintellect PowerCollections

previous page next page

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Returns a View collection that can be used for enumerating a range of the items in the bag. Only items that are less than (and optionally, equal to) to are included. The items are enumerated in sorted order. Items equal to to can be included or excluded depending on the toInclusive parameter.

Namespace: Wintellect.PowerCollections
Assembly: PowerCollections (in PowerCollections.dll)

Syntax

C#
public OrderedBag<T>.OrderedBag<(Of <T>)>..::View RangeTo( T to, bool toInclusive )

Visual Basic (Declaration)
Public Function RangeTo ( _ to As T, _ toInclusive As Boolean _ ) As OrderedBag<(Of <T>)>..::View

Visual C++
public: OrderedBag<(Of <T>)>..::View^ RangeTo ( T to, bool toInclusive )

Parameters

to: T
The upper bound of the range.

toInclusive: Boolean
If true, the upper bound is inclusive--items equal to the upper bound will be included in the range. If false, the upper bound is exclusive--items equal to the upper bound will not be included in the range.

Return Value

An OrderedBag.View of items in the given range.

Remarks

Typically, this method is used in conjunction with a foreach statement. For example:

	Copy Code
foreach(T item in bag.RangeTo(to, false)) { // process item }

If an item is added to or deleted from the bag while the View is being enumerated, then the enumeration will end with an InvalidOperationException.

Calling RangeTo does not copy the data in the tree, and the operation takes constant time.